gh-144161: Clarify additional immortalization in free-threaded build #144176
+9
−3
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…build Clarify that the objects listed in the free-threading HOWTO are additional immortalizations specific to the free-threaded build. This addresses the inconsistency with sys.intern() documentation, which describes the default (mortal) behavior.
|
All commit authors signed the Contributor License Agreement. |
Member
ZeroIntensity
left a comment
ZeroIntensity
left a comment
There was a problem hiding this comment.
I think it would make much more sense to just add a note to sys.intern and PyUnicode_InternInPlace saying that the free-threaded build makes all interned strings immortal.
Contributor
Prometheus3375
left a comment
Prometheus3375
left a comment
There was a problem hiding this comment.
LGTM, though perhaps in both "Note" blocks I would also highlight "are" in bold as on the picture below.
Doc/c-api/unicode.rst
Outdated
Comment on lines
1753
to
1755
| Note that interned strings are not “immortal”. | ||
| You must keep a reference to the result to benefit from interning. | ||
Contributor
There was a problem hiding this comment.
Just to avoid double "Note", here's rephrase of the previous paragraph.
Suggested change
| Note that interned strings are not “immortal”. | |
| You must keep a reference to the result to benefit from interning. | |
| Interned strings are not :term:`immortal`. | |
| You must keep a reference to the result to benefit from interning. |
Doc/c-api/unicode.rst
Outdated
| You must keep a reference to the result to benefit from interning. | ||
| .. note:: | ||
| On the free-threaded build, all interned strings are :term:`immortal`. |
Member
There was a problem hiding this comment.
Sorry I messed up the suggestion, the right term is "free threading":
Suggested change
| On the free-threaded build, all interned strings are :term:`immortal`. | |
| On the :term:`free threaded <free threading>` build, all interned strings are :term:`immortal`. |
| You must keep a reference to the result to benefit from interning. | ||
| .. note:: | ||
| On the :term:`free threaded <free threading>` build, all interned strings are :term:`immortal`. |
Contributor
There was a problem hiding this comment.
Suggested change
| On the :term:`free threaded <free threading>` build, all interned strings are :term:`immortal`. | |
| On the :term:`free threaded <free threading>` build, | |
| all interned strings are :term:`immortal`. |
| return value of :func:`intern` around to benefit from it. | ||
|
|
||
| .. note:: | ||
| On the :term:`free threaded <free threading>` build, all interned strings are :term:`immortal`. |
Contributor
There was a problem hiding this comment.
Suggested change
| On the :term:`free threaded <free threading>` build, all interned strings are :term:`immortal`. | |
| On the :term:`free threaded <free threading>` build, | |
| all interned strings are :term:`immortal`. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Clarify that the objects listed in the free-threading HOWTO are additional immortalizations specific to the free-threaded build.
This addresses the inconsistency reported in #144161, where
sys.intern()documentation states that interned strings are not immortal, while the free-threading HOWTO suggested otherwise. Both are correct for their respective contexts (default vs. free-threaded builds).Changes follow the suggestion by @Prometheus3375 in the issue discussion.
📚 Documentation preview 📚: https://cpython-previews--144176.org.readthedocs.build/